org.springframework.test.web.reactive.server

Class DefaultWebTestClientBuilder

java.lang.Object

org.springframework.test.web.reactive.server.DefaultWebTestClientBuilder

All Implemented Interfaces:

WebTestClient.Builder

class DefaultWebTestClientBuilder
extends java.lang.Object
implements WebTestClient.Builder

Default implementation of WebTestClient.Builder.

Since:

5.0

Author:

Rossen Stoyanchev

Field Summary

Fields

Modifier and Type	Field and Description
private ClientHttpConnector	connector
private WebHttpHandlerBuilder	httpHandlerBuilder
private java.time.Duration	responseTimeout
private WebClient.Builder	webClientBuilder

Constructor Summary

Constructors

Modifier	Constructor and Description
(package private)	DefaultWebTestClientBuilder() Connect to server via Reactor Netty
(package private)	DefaultWebTestClientBuilder(ClientHttpConnector connector) Connect to server through the given connector
(package private)	DefaultWebTestClientBuilder(DefaultWebTestClientBuilder other) Copy constructor
private	DefaultWebTestClientBuilder(WebClient.Builder webClientBuilder, WebHttpHandlerBuilder httpHandlerBuilder, ClientHttpConnector connector, java.time.Duration responseTimeout)
(package private)	DefaultWebTestClientBuilder(WebHttpHandlerBuilder httpHandlerBuilder) Connect to given mock server with mock request and response

Method Summary

Modifier and Type	Method and Description
WebTestClient.Builder	apply(WebTestClientConfigurer configurer) Shortcut for pre-packaged customizations to WebTestClient builder.
WebTestClient.Builder	baseUrl(java.lang.String baseUrl) Configure a base URI as described in WebClient.create(String).
WebTestClient	build() Build the WebTestClient instance.
WebTestClient.Builder	defaultCookie(java.lang.String cookieName, java.lang.String... cookieValues) Add the given header to all requests that haven't added it.
WebTestClient.Builder	defaultCookies(java.util.function.Consumer<MultiValueMap<java.lang.String,java.lang.String>> cookiesConsumer) Manipulate the default cookies with the given consumer.
WebTestClient.Builder	defaultHeader(java.lang.String headerName, java.lang.String... headerValues) Add the given header to all requests that haven't added it.
WebTestClient.Builder	defaultHeaders(java.util.function.Consumer<HttpHeaders> headersConsumer) Manipulate the default headers with the given consumer.
WebTestClient.Builder	exchangeStrategies(ExchangeStrategies strategies) Configure the ExchangeStrategies to use.
WebTestClient.Builder	filter(ExchangeFilterFunction filter) Add the given filter to the filter chain.
WebTestClient.Builder	filters(java.util.function.Consumer<java.util.List<ExchangeFilterFunction>> filtersConsumer) Manipulate the filters with the given consumer.
WebTestClient.Builder	responseTimeout(java.time.Duration timeout) Max amount of time to wait for responses.
WebTestClient.Builder	uriBuilderFactory(UriBuilderFactory uriBuilderFactory) Provide a pre-configured UriBuilderFactory instance as an alternative to and effectively overriding WebTestClient.Builder.baseUrl(String).

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

webClientBuilder

private final WebClient.Builder webClientBuilder

httpHandlerBuilder

@Nullable
private final WebHttpHandlerBuilder httpHandlerBuilder

connector

@Nullable
private final ClientHttpConnector connector

responseTimeout

@Nullable
private java.time.Duration responseTimeout

Constructor Detail

DefaultWebTestClientBuilder

DefaultWebTestClientBuilder()

Connect to server via Reactor Netty

DefaultWebTestClientBuilder

DefaultWebTestClientBuilder(ClientHttpConnector connector)

Connect to server through the given connector

DefaultWebTestClientBuilder

DefaultWebTestClientBuilder(WebHttpHandlerBuilder httpHandlerBuilder)

Connect to given mock server with mock request and response

DefaultWebTestClientBuilder

DefaultWebTestClientBuilder(DefaultWebTestClientBuilder other)

Copy constructor

DefaultWebTestClientBuilder

private DefaultWebTestClientBuilder(@Nullable
                                    WebClient.Builder webClientBuilder,
                                    @Nullable
                                    WebHttpHandlerBuilder httpHandlerBuilder,
                                    @Nullable
                                    ClientHttpConnector connector,
                                    @Nullable
                                    java.time.Duration responseTimeout)

Method Detail

baseUrl

public WebTestClient.Builder baseUrl(java.lang.String baseUrl)

Description copied from interface: WebTestClient.Builder

Configure a base URI as described in WebClient.create(String).

Specified by:

baseUrl in interface WebTestClient.Builder

uriBuilderFactory

public WebTestClient.Builder uriBuilderFactory(UriBuilderFactory uriBuilderFactory)

Description copied from interface: WebTestClient.Builder

Provide a pre-configured UriBuilderFactory instance as an alternative to and effectively overriding WebTestClient.Builder.baseUrl(String).

Specified by:

uriBuilderFactory in interface WebTestClient.Builder

defaultHeader

public WebTestClient.Builder defaultHeader(java.lang.String headerName,
                                           java.lang.String... headerValues)

Description copied from interface: WebTestClient.Builder

Add the given header to all requests that haven't added it.

Specified by:

defaultHeader in interface WebTestClient.Builder

Parameters:

headerName - the header name

headerValues - the header values

defaultHeaders

public WebTestClient.Builder defaultHeaders(java.util.function.Consumer<HttpHeaders> headersConsumer)

Description copied from interface: WebTestClient.Builder

Manipulate the default headers with the given consumer. The headers provided to the consumer are "live", so that the consumer can be used to overwrite existing header values, remove values, or use any of the other HttpHeaders methods.

Specified by:

defaultHeaders in interface WebTestClient.Builder

Parameters:

headersConsumer - a function that consumes the HttpHeaders

Returns:

this builder

defaultCookie

public WebTestClient.Builder defaultCookie(java.lang.String cookieName,
                                           java.lang.String... cookieValues)

Description copied from interface: WebTestClient.Builder

Add the given header to all requests that haven't added it.

Specified by:

defaultCookie in interface WebTestClient.Builder

Parameters:

cookieName - the cookie name

cookieValues - the cookie values

defaultCookies

public WebTestClient.Builder defaultCookies(java.util.function.Consumer<MultiValueMap<java.lang.String,java.lang.String>> cookiesConsumer)

Description copied from interface: WebTestClient.Builder

Manipulate the default cookies with the given consumer. The map provided to the consumer is "live", so that the consumer can be used to overwrite existing header values, remove values, or use any of the other MultiValueMap methods.

Specified by:

defaultCookies in interface WebTestClient.Builder

Parameters:

cookiesConsumer - a function that consumes the cookies map

Returns:

this builder

filter

public WebTestClient.Builder filter(ExchangeFilterFunction filter)

Description copied from interface: WebTestClient.Builder

Add the given filter to the filter chain.

Specified by:

filter in interface WebTestClient.Builder

Parameters:

filter - the filter to be added to the chain

filters

public WebTestClient.Builder filters(java.util.function.Consumer<java.util.List<ExchangeFilterFunction>> filtersConsumer)

Description copied from interface: WebTestClient.Builder

Manipulate the filters with the given consumer. The list provided to the consumer is "live", so that the consumer can be used to remove filters, change ordering, etc.

Specified by:

filters in interface WebTestClient.Builder

Parameters:

filtersConsumer - a function that consumes the filter list

Returns:

this builder

exchangeStrategies

public WebTestClient.Builder exchangeStrategies(ExchangeStrategies strategies)

Description copied from interface: WebTestClient.Builder

Configure the ExchangeStrategies to use.

By default ExchangeStrategies.withDefaults() is used.

Specified by:

exchangeStrategies in interface WebTestClient.Builder

Parameters:

strategies - the strategies to use

responseTimeout

public WebTestClient.Builder responseTimeout(java.time.Duration timeout)

Description copied from interface: WebTestClient.Builder

Max amount of time to wait for responses.

By default 5 seconds.

Specified by:

responseTimeout in interface WebTestClient.Builder

Parameters:

timeout - the response timeout value

apply

public WebTestClient.Builder apply(WebTestClientConfigurer configurer)

Description copied from interface: WebTestClient.Builder

Shortcut for pre-packaged customizations to WebTestClient builder.

Specified by:

apply in interface WebTestClient.Builder

Parameters:

configurer - the configurer to apply

build

public WebTestClient build()

Description copied from interface: WebTestClient.Builder

Build the WebTestClient instance.

Specified by:

build in interface WebTestClient.Builder